api/fileAttachments/{id} (Get)

Get	api/fileAttachments/{id}

In This Topic

Resource Path: /sites/{company-id}/api/fileAttachments/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/fileAttachments/{id}

Description

Retrieves a single FileAttachment object assigned to a given identifier.

Parameters

Name	Description	Data Type
id	The unique identifier of a FileAttachment as a Guid.	string

200 Response

The response body is of type FileAttachment.

Returns a comprehensive FileAttachment object.

FileAttachment

Represents a comprehensive FileAttachment record within the OnTime API.

ID : string

The unique identifier for this FileAttachment record.

FileName : string

The exact file name of the FileAttachment.

Contents : string

An array of unsigned bytes representing the raw data for this FileAttachment.

Timestamp : string

The date and time that that this FileAttachment was created.

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.